Microsoft Cognitive Language Service - Analyze Conversations Authoring (preview:2023-04-15)

2025/03/24 • 9 new methods

ConversationAuthoringListProjects (new)
Description Lists the existing projects.
Reference Link ¶

⚼ Request

GET:  /authoring/analyze-conversations/projects
{
api-version: string ,
top: integer ,
skip: integer ,
maxpagesize: integer ,
}

⚐ Response (200)

{
value:
[
{
createdDateTime: string ,
lastModifiedDateTime: string ,
lastTrainedDateTime: string ,
lastDeployedDateTime: string ,
projectKind: enum ,
settings:
{
confidenceThreshold: number ,
}
,
storageInputContainerName: string ,
projectName: string ,
multilingual: boolean ,
description: string ,
language: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}
ConversationAuthoringListDeployments (new)
Description Lists the deployments belonging to a project.
Reference Link ¶

⚼ Request

GET:  /authoring/analyze-conversations/projects/{projectName}/deployments
{
api-version: string ,
projectName: string ,
top: integer ,
skip: integer ,
maxpagesize: integer ,
}

⚐ Response (200)

{
value:
[
{
deploymentName: string ,
modelId: string ,
lastTrainedDateTime: string ,
lastDeployedDateTime: string ,
deploymentExpirationDate: string ,
modelTrainingConfigVersion: string ,
assignedResources:
[
{
resourceId: string ,
region: string ,
}
,
]
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}
ConversationAuthoringListTrainedModels (new)
Description Lists the trained models belonging to a project.
Reference Link ¶

⚼ Request

GET:  /authoring/analyze-conversations/projects/{projectName}/models
{
api-version: string ,
projectName: string ,
top: integer ,
skip: integer ,
maxpagesize: integer ,
}

⚐ Response (200)

{
value:
[
{
label: string ,
modelId: string ,
lastTrainedDateTime: string ,
lastTrainingDurationInSeconds: integer ,
modelExpirationDate: string ,
modelTrainingConfigVersion: string ,
hasSnapshot: boolean ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}
ConversationAuthoringListDeploymentResources (new)
Description Lists the deployments resources assigned to the project.
Reference Link ¶

⚼ Request

GET:  /authoring/analyze-conversations/projects/{projectName}/resources
{
api-version: string ,
projectName: string ,
top: integer ,
skip: integer ,
maxpagesize: integer ,
}

⚐ Response (200)

{
value:
[
{
azureResourceId: string ,
region: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}
ConversationAuthoringListTrainingJobs (new)
Description Lists the non-expired training jobs created for a project.
Reference Link ¶

⚼ Request

GET:  /authoring/analyze-conversations/projects/{projectName}/train/jobs
{
api-version: string ,
projectName: string ,
top: integer ,
skip: integer ,
maxpagesize: integer ,
}

⚐ Response (200)

{
value:
[
{
jobId: string ,
createdDateTime: string ,
lastUpdatedDateTime: string ,
expirationDateTime: string ,
status: enum ,
warnings:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
]
,
errors:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
]
,
result:
{
modelLabel: string ,
trainingConfigVersion: string ,
trainingMode: enum ,
trainingStatus:
{
percentComplete: integer ,
startDateTime: string ,
endDateTime: string ,
status: enum ,
}
,
evaluationStatus:
{
percentComplete: integer ,
startDateTime: string ,
endDateTime: string ,
status: enum ,
}
,
estimatedEndDateTime: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}
ConversationAuthoringListAssignedResourceDeployments (new)
Description Lists the deployments to which an Azure resource is assigned. This doesn't return deployments belonging to projects owned by this resource. It only returns deployments belonging to projects owned by other resources.
Reference Link ¶

⚼ Request

GET:  /authoring/analyze-conversations/projects/global/deployments/resources
{
api-version: string ,
top: integer ,
skip: integer ,
maxpagesize: integer ,
}

⚐ Response (200)

{
value:
[
{
projectName: string ,
deploymentsMetadata:
[
{
deploymentName: string ,
lastDeployedDateTime: string ,
deploymentExpirationDate: string ,
}
,
]
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}
ConversationAuthoringListSupportedLanguages (new)
Description Lists the supported languages for the given project type.
Reference Link ¶

⚼ Request

GET:  /authoring/analyze-conversations/projects/global/languages
{
api-version: string ,
top: integer ,
skip: integer ,
maxpagesize: integer ,
projectKind: string ,
}

⚐ Response (200)

{
value:
[
{
languageName: string ,
languageCode: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}
ConversationAuthoringListSupportedPrebuiltEntities (new)
Description Lists the supported prebuilt entities that can be used while creating composed entities.
Reference Link ¶

⚼ Request

GET:  /authoring/analyze-conversations/projects/global/prebuilt-entities
{
api-version: string ,
top: integer ,
skip: integer ,
maxpagesize: integer ,
language: string ,
multilingual: string ,
}

⚐ Response (200)

{
value:
[
{
category: string ,
description: string ,
examples: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}
ConversationAuthoringListTrainingConfigVersions (new)
Description Lists the support training config version for a given project type.
Reference Link ¶

⚼ Request

GET:  /authoring/analyze-conversations/projects/global/training-config-versions
{
api-version: string ,
top: integer ,
skip: integer ,
maxpagesize: integer ,
projectKind: string ,
}

⚐ Response (200)

{
value:
[
{
trainingConfigVersion: string ,
modelExpirationDate: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}